Creare una dilazione
Introduzione
Per attivare una dilazione o un pagamento è necessario prima inviare una richiesta di dilazione, quindi reindirizzare l'utente al gateway di pagamento con l'identificativo della dilazione ricevuto, passando un URL di ritorno. Il gateway reindirizzerà all'URL inviato per gestire il ritorno del pagamento.
Inviare una richiesta di dilazione
L'endpoint chiede l'avviamento della dilazione e ritorna l'identificativo per il reindirizzamento.
Richiesta Http
POST https://api.jatapay.it/scrivi_dilazione
Parametri
| Parametro | Richiesto | Tipo | Descrizione |
|---|---|---|---|
| importo | Sì | int | L'importo della dilazione espresso in centesimi di Euro |
| rate | Sì | int | Il numero di rate della dilazione |
| callback_url | Sì | string | Un URL Valido per il ritorno del pagamento |
| consenso_debit | No | boolean | Abilita l'accettazione delle carte di debito e/o prepagate, obbligatorio per rate differenziate |
| differenziate | No | boolean | Abilita rate a importi differenti, obbligatorio per rate differenziate |
| dettaglio_rate | No | int[] | L'importo di ogni rata espresso in centesimi, la lunghezza dell'array deve essere uguale al numero di rate,obbligatorio per rate differenziate |
| note | No | string | Delle note descrittive per la dilazione |
| descrizione_prodotto | Sì | string | La descrizione del prodotto |
| cliente | Sì | string | Utilizzare il valore 'open' |
- shell
- PHP
- Python
curl "https://api.jatapay.it/scrivi_dilazione" \
-H "Authorization: Bearer IL_TOKEN_DI_ACCESSO" \
-d = '{}'
$dati_dilazione = array(
'importo' => 2000, //Importo in centesimi di euro
'rate' => (int)2 //Numero di rate,
'callback_url' => 'https://e-commerce.example.com/callback_url',
'note' => 'Dilazione per motivo esempio',
'cliente' => 'open',
'descrizione_prodotto' => 'Descrizione del prodotto'
);
$url = curl_init("https://api.jatapay.it/scrivi_dilazione");
$authorization = "Authorization: Bearer ".$token;
curl_setopt($url, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($url, CURLOPT_POSTFIELDS, json_encode($dati_dilazione));
curl_setopt($url, CURLOPT_RETURNTRANSFER, true);
curl_setopt($url, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen(json_encode($dati_dilazione)),
$authorization
));
$result = curl_exec($url);
$api_response = json_decode($result);
curl_close($url);
import requests
import json
dati_dilazione = {
'importo': 2000, # Importo in centesimi di euro
'rate': 2, # Numero di rate
'callback_url': 'https://e-commerce.example.com/callback_url',
'note': 'Dilazione per motivo esempio',
'cliente': 'open',
'descrizione_prodotto': 'Descrizione del prodotto'
}
url = "https://api.jatapay.it/scrivi_dilazione"
token = "your_access_token" # il tuo token
authorization = "Bearer " + token
headers = {
'Content-Type': 'application/json',
'Authorization': authorization
}
response = requests.post(url, data=json.dumps(dati_dilazione), headers=headers)
api_response = response.json()
print(api_response)
Il comando ritornerà un JSON con questa struttura:
{
"id_dilazione": "ID_DELLA_DILAZIONE"
}
warning
La richiesta deve avere l'header Content-Type: application/json e includere il parametro nel corpo del JSON e l'header Authorization: Bearer token
Reindirizzare l'utente al gateway di pagamento
Una volta ottenuto l'id della dilazione è necessario reindirizzare l'utente al gateway di pagamento all'url:
https://dashboard.jatapay.com/gateway/ID_DELLA_DILAZIONE
warning
Sostituire ID_DELLA_DILAZIONE con l'id ottenuto in precedenza
L'utente completerà il processo di pagamento e sarà reindirizzato all'url passato in precedenza.
Gestire il ritorno del pagamento
In qualunque momento sarà possibile recuperare le informazioni sulla dilazione per il controllo dell'avvenuta attivazione della stessa.
GET https://api.jatapay.it/entity/dilazioni/ID_DELLA_DILAZIONE
warning
Sostituire ID_DELLA_DILAZIONE con l'id ottenuto in precedenza
Lo stato dilazione 'attiva' indica l'accettazione della dilazione
- shell
- PHP
- Python
curl "https://api.jatapay.it/entity/dilazioni/ID_DELLA_DILAZIONE" \
-H "Authorization: Bearer IL_TOKEN_DI_ACCESSO" \
$urlstring = "https://api.jatapay.it/entity/dilazioni/".$_GET['id_dilazione'];
$url = curl_init($urlstring);
$authorization = "Authorization: Bearer ".$token;
curl_setopt($url, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($url, CURLOPT_RETURNTRANSFER, true);
curl_setopt($url, CURLOPT_HTTPHEADER, array(
$authorization
));
$result = curl_exec($url);
curl_close($url);
$api_response = json_decode($result);
import requests
import cgi
form = cgi.FieldStorage()
id_dilazione = form.getValue('id_dilazione')
token = 'IL_TUO_TOKEN'
headers = {"Authorization": "Bearer " + token}
url = 'https://api.jatapay.it/entity/dilazioni/' + id_dilazione
response = requests.get(url,headers=headers)
if response.status_code == 200:
response = response.json()
else:
print('Error, ' + str(response.status_code))
Il comando ritornerà un JSON con questa struttura:
{
"_id": "ID_DELLA_DILAZIONE",
"base": 0, //questo è il valore base della dilazione qualora si usassero rate differenziate
"callback_url":"https://my-ecommerce.example.com/callback_url", //il callback_url massato in precedenza
"carta": "6dasde43eww6c4039f27", //l'identificativo della carta del cliente
"client": "JataPay",
"cliente": "5f12321was23e3ec1422", //l'identificativo del cliente
"contratto": {
"pdf": "6065ef23se35d684823ec387", //l'identificativo del contratto di dilazione
},
"data_fine": "Sat, 01 May 2021 18:05:04 GMT", //la data fine della dilazione
"data_inizio": "Thu, 01 Apr 2021 18:05:04 GMT", //la data inizio della dilazione
"data_inserimento": "Thu, 01 Apr 2021 16:05:06 GMT", //la data inserimento della dilazione
"date_differenziate": false,
"esercente": "6022a3c41bsa3653fsib044", //il vostro identificativo
"importo": 200, //l'importo in centesimi di euro
"metadata": null,
"note": "", //le note inserite
"numero": 526, //il numero della dilazione
"rate": 2,
"rate_differenziate": false, //se la dilazione ha o meno rate differenziate
"stato": "attiva", //lo stato della dilazione
"tipo": "credit", //il tipo
}